This is the documentation for Enlighten.
class Enlighten BaseSystem
class Enlighten::BaseSystem
Base class which holds everything a system must have (regardless of where the solving happens).
Functions
| Name | Description |
|---|---|
| HasAlbedoData() | Property-setting functions which can be enqueued with EnqueueSetObjectParameter. |
| Release() | Free this object that was created within the Enlighten libraries. |
| Release() | Free this object that was created within the Enlighten libraries. |
| SetAlbedoData(Enlighten::SystemAlbedoData) | Property-setting functions which can be enqueued with EnqueueSetObjectParameter. |
| SetBounceScale(float) | Property-setting functions which can be enqueued with EnqueueSetObjectParameter. |
| SetDirectionalLightInputScale(float) | Property-setting functions which can be enqueued with EnqueueSetObjectParameter. |
| SetEmissiveEnvironment(Geo::GeoGuid) | Property-setting functions which can be enqueued with EnqueueSetObjectParameter. |
| SetFramesPerUpdate(Geo::s32) | Property-setting functions which can be enqueued with EnqueueSetObjectParameter. |
| SetSystemSolutionSpace(ISystemSolutionSpace *) | Set a single solution space for this system. |
| SetSystemSolutionSpaces(ISystemSolutionSpace *const *, const Geo::s32, const Geo::s32) | Set multiple solution spaces for this system. |
| SetTemporalCoherenceThreshold(float) | Property-setting functions which can be enqueued with EnqueueSetObjectParameter. |
| SetTransparencyEnabled(bool) | Set whether or not Transparency should be computed in the HLRT. |
| SetUpdateCounter(Geo::s32) | Property-setting functions which can be enqueued with EnqueueSetObjectParameter. |
| UpdateFrameCounter() | Property-setting functions which can be enqueued with EnqueueSetObjectParameter. |
bool Enlighten::BaseSystem::HasAlbedoData
public: bool HasAlbedoData()
Property-setting functions which can be enqueued with EnqueueSetObjectParameter.
virtual void Enlighten::BaseSystem::Release
protected: virtual void Release()
Free this object that was created within the Enlighten libraries.
Expect this to behave in a similar way to calling 'delete(this)'
virtual void Geo::IGeoReleasable::Release
public: void Release()
Free this object that was created within the Enlighten libraries.
Expect this to behave in a similar way to calling 'delete(this)'
virtual void Enlighten::BaseSystem::SetAlbedoData
public: virtual void SetAlbedoData
(
Enlighten::SystemAlbedoData albedoData
)
Property-setting functions which can be enqueued with EnqueueSetObjectParameter.
void Enlighten::BaseSystem::SetBounceScale
public: void SetBounceScale
(
float s
)
Property-setting functions which can be enqueued with EnqueueSetObjectParameter.
void Enlighten::BaseSystem::SetDirectionalLightInputScale
public: void SetDirectionalLightInputScale
(
float s
)
Property-setting functions which can be enqueued with EnqueueSetObjectParameter.
void Enlighten::BaseSystem::SetEmissiveEnvironment
public: void SetEmissiveEnvironment
(
Geo::GeoGuid id
)
Property-setting functions which can be enqueued with EnqueueSetObjectParameter.
void Enlighten::BaseSystem::SetFramesPerUpdate
public: void SetFramesPerUpdate
(
Geo::s32 f
)
Property-setting functions which can be enqueued with EnqueueSetObjectParameter.
void Enlighten::BaseSystem::SetSystemSolutionSpace
public: void SetSystemSolutionSpace
(
ISystemSolutionSpace * solutionSpace
)
Set a single solution space for this system.
void Enlighten::BaseSystem::SetSystemSolutionSpaces
public: void SetSystemSolutionSpaces
(
ISystemSolutionSpace *const * solutionSpaces,
const Geo::s32 solutionSpacesCount,
const Geo::s32 indexForBounceResampling
)
Set multiple solution spaces for this system.
The order of the elements in the input array is NOT preserved.
Parameters
| solutionSpaces | An array of solution spaces with different output pixel sizes. |
|
| solutionSpacesCount | Number of solution spaces in the array. |
|
| indexForBounceResampling | The index for the solution space to use for bounce resampling. Should be the index of the solution space with the smallest output pixel size. |
void Enlighten::BaseSystem::SetTemporalCoherenceThreshold
public: void SetTemporalCoherenceThreshold
(
float t
)
Property-setting functions which can be enqueued with EnqueueSetObjectParameter.
void Enlighten::BaseSystem::SetTransparencyEnabled
public: void SetTransparencyEnabled
(
bool enabled
)
Set whether or not Transparency should be computed in the HLRT.
virtual void Enlighten::BaseSystem::SetUpdateCounter
public: virtual void SetUpdateCounter
(
Geo::s32 c
)
Property-setting functions which can be enqueued with EnqueueSetObjectParameter.
void Enlighten::BaseSystem::UpdateFrameCounter
public: void UpdateFrameCounter()
Property-setting functions which can be enqueued with EnqueueSetObjectParameter.